Postman collection
To understand better how our API works and speed up your integration process, you can download our Postman collection. In order to use it, the following will be provided to you by your account/project manager:
- API Key + Secret.
- Requirements for onboarding of legal entities or natural persons.
- Program code needed for account/card creation.
- Others - depending on your business case.
Download Postman
You can download and install Postman on all operating systems from https://www.postman.com/downloads/
Download Paynetics API Postman Collection
Click here.Import Postman Collection
First things first. You need to import the collection into your Postman App.
In top left corner there is import button which will open modal where you can add the file downloaded in step 2.
Please see below the provided examples one and two :
In top left corner there is import button which will open modal where you can add the file downloaded in step 2.
Please see below the provided examples one and two :
Example one
Example two
Configuration
After successfully importing the collection you need to make simple configuration.
Click on the collection variable section where you will find API_KEY and API_SECRET variables.
Please enter the credentials provided to you by your account/project manager.
Click on the collection variable section where you will find API_KEY and API_SECRET variables.
Please enter the credentials provided to you by your account/project manager.
! BE AWARE THAT BOTH INITIAL AND CURRENT VALUE FIELDS MUST BE FILED !
Usage & Guidelines
You can now start using the collection and explore the API.
Just few additional tips and todos.
Each body of each request is located in Pre Request section.
The pre request script execute a function which will calculate the authentication value and add need headers for authentication.
The operation and body of the request (if any) are passed as arguments to the function which authenticates the request.
You can use this function for additional request in order to authenticate.
Just few additional tips and todos.
Each body of each request is located in Pre Request section.
The pre request script execute a function which will calculate the authentication value and add need headers for authentication.
The operation and body of the request (if any) are passed as arguments to the function which authenticates the request.
You can use this function for additional request in order to authenticate.
Add JSON Body Sections
There will some parts of the json body which must be added by you.
You will find the as {{ todo sections }} with explanation what must be done.
You will find the as {{ todo sections }} with explanation what must be done.
- For legal entities onboarding after successful request tokens of the application and company members will added as variables for subsequent requests.
- For natural persons onboarding after successful request user token will be added as variable which can be used for sub requests.
- For account creation you can add program as variable in collection or replace it on each request. After successful account creation account token will be added as variable and can be used for sub requests.
- For non personalized card creation you can add program as variable in collection or replace it on each request. After successful card creation account card will be added as variable and can be used for sub requests.
- For transfers you will need either debtor/creditor identifiers of the balances or for external transfers valid creditor IBAN/AccountNumber and Sort Code.
- For all API which return list of entities like transactions list, accounts list etc, you can find all available filters in Params section of the request.
